GET /manage/v2/databases/{id|name}/alert/actions/{id|name}/properties
Summary
This resource address returns the configuration properties of the named alert
action.
URL Parameters |
uri |
The URI of the alert that uses this action. This
parameter is required. |
format |
The format of the posted data. Can be either
json or xml (default). This value overrides the Accept header if
both are present. |
Request Headers |
Accept |
The expected MIME type of the request body. If
the format? parameter is present, it takes precedence over the Accept header. |
Content-type |
The MIME type of the data in the request
body. Depending upon the value of the format parameter or Accept header, one of
application/xml , application/json , or text/html . |
Response Headers |
Content-type |
The MIME type of the data in the response
body. Depending upon the value of the format parameter or Accept header, one of
application/xml , application/json , or text/html .
|
Response
Upon success, MarkLogic Server returns status code 200 (OK). The response body
contains the requested data. If the payload is malformed, a status code of 400 (Bad Request)
is returned. A status code of 401 (Unauthorized) is returned if the user does not have the
necessary privileges.
Required Privileges
This operation requires the
manage-user
role, or the following
privilege:
http://marklogic.com/xdmp/privileges/manage
Usage Notes
The structure of the output returned from
this REST API is as follows:
name
description
module-db
module-root
module
options
Example
curl -X GET --anyauth -u admin:admin --header "Content-Type:application/json" \
http://localhost:8002/manage/v2/databases/Documents/alert/actions/xdmp:log2/properties?uri=my-alert-config
==> Returns the properties of the "xdmp:log2" alert action for the Documents
database.
Copyright © 2024 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.